﻿#region Header
// ------------------------ Licence / Copyright ------------------------
// 
// ScrumTable for Scrum Meeting Support
// Copyright © HSR - Hochschule für Technik Rapperswil
// All Rights Reserved
// 
// Author:
//  Michael Gfeller Silvan Gehrig Patrick Boos
// 
// ---------------------------------------------------------------------
#endregion

#region Usings

using System;
using ScrumTable.Common;

#endregion

namespace ScrumTable.DL.Data.Common
{
    /// <summary>
    /// The data storage interface contains the data access objects
    /// required by the ScrumTable.
    /// </summary>
    public interface IDataStorage : IDisposable
    {
        #region Properties
        //--------------------------------------------------------------------
        // Properties
        //--------------------------------------------------------------------

        /// <summary>
        /// Gets the data access object with the given name.
        /// </summary>
        /// <param name="name">Name of the data access object to obtain.</param>
        /// <returns>Returns the retrieved data acces object.</returns>
        IDataAccessObject this[string name] { get; }

        #endregion

        #region Methods
        //--------------------------------------------------------------------
        // Methods
        //--------------------------------------------------------------------

        /// <summary>
        /// Clears all data access objects in the current storage.
        /// </summary>
        void Clear();

        #endregion

        #region Events
        //--------------------------------------------------------------------
        // Events
        //--------------------------------------------------------------------

        #endregion
    }
}